Skip to content

Update version to 2.2.12 across project files#511

Merged
MervinPraison merged 1 commit intomainfrom
develop
May 24, 2025
Merged

Update version to 2.2.12 across project files#511
MervinPraison merged 1 commit intomainfrom
develop

Conversation

@MervinPraison
Copy link
Copy Markdown
Owner

@MervinPraison MervinPraison commented May 24, 2025

  • Incremented PraisonAI version from 2.2.11 to 2.2.12 in pyproject.toml, uv.lock, and all relevant Dockerfiles for consistency.
  • Ensured minimal changes to existing code while maintaining versioning accuracy across the project.

Summary by CodeRabbit

  • New Features
    • Updated the PraisonAI package to version 2.2.12 across all Docker environments and documentation.
  • Documentation
    • Revised setup and deployment instructions to reflect the new PraisonAI version.
  • Chores
    • Incremented the project version to 2.2.12.
  • Refactor
    • Improved internal handling of API key configuration for language model integration.
  • Style
    • Removed unnecessary whitespace from workflow configuration files.

- Incremented PraisonAI version from 2.2.11 to 2.2.12 in `pyproject.toml`, `uv.lock`, and all relevant Dockerfiles for consistency.
- Ensured minimal changes to existing code while maintaining versioning accuracy across the project.
@MervinPraison MervinPraison merged commit d42e76f into main May 24, 2025
9 of 10 checks passed
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented May 24, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This change updates the pinned version of the praisonai Python package from 2.2.11 to 2.2.12 across multiple Dockerfiles, documentation files, and project metadata. Additionally, it removes explicit API key handling in the _run_crewai method of praisonai/agents_generator.py and eliminates a trailing whitespace in a GitHub Actions workflow.

Changes

Files/Paths Change Summary
docker/Dockerfile, docker/Dockerfile.chat, docker/Dockerfile.dev, docker/Dockerfile.ui Updated praisonai package version from 2.2.11 to 2.2.12 in all Dockerfiles.
docs/api/praisonai/deploy.html, praisonai/deploy.py Updated Dockerfile creation logic to use praisonai version 2.2.12.
docs/developers/local-development.mdx, docs/ui/chat.mdx, docs/ui/code.mdx Updated documentation to reference praisonai version 2.2.12 in Docker instructions.
pyproject.toml Updated project version from 2.2.11 to 2.2.12 in metadata sections.
.github/workflows/unittest.yml Removed a trailing whitespace after the runs-on: ubuntu-latest line.
praisonai/agents_generator.py Removed explicit disabling of env var API key lookup and manual API key assignment in _run_crewai.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AgentsGenerator
    participant PraisonAIModel

    User->>AgentsGenerator: Call _run_crewai(config_list)
    AgentsGenerator->>PraisonAIModel: Instantiate LLM model with config_list
    Note right of PraisonAIModel: API key automatically resolved (no manual override)
    AgentsGenerator->>AgentsGenerator: Create agents and tasks
    AgentsGenerator->>AgentsGenerator: Run CrewAI crew
    AgentsGenerator-->>User: Return results
Loading

Possibly related PRs

Suggested labels

Review effort 1/5

Poem

A whisk of code, a gentle nudge,
Now PraisonAI gets a version fudge!
Dockerfiles aligned, docs in sync,
API keys let the models think.
With 2.2.12, we hop ahead—
A rabbit’s update, lightly spread!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2e63a14 and 059591f.

⛔ Files ignored due to path filters (1)
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (12)
  • .github/workflows/unittest.yml (1 hunks)
  • docker/Dockerfile (1 hunks)
  • docker/Dockerfile.chat (1 hunks)
  • docker/Dockerfile.dev (1 hunks)
  • docker/Dockerfile.ui (1 hunks)
  • docs/api/praisonai/deploy.html (1 hunks)
  • docs/developers/local-development.mdx (1 hunks)
  • docs/ui/chat.mdx (1 hunks)
  • docs/ui/code.mdx (1 hunks)
  • praisonai/agents_generator.py (1 hunks)
  • praisonai/deploy.py (1 hunks)
  • pyproject.toml (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @MervinPraison, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

Hello team, gemini-code-assist here to provide a summary of this pull request. The primary intent of this PR, as stated in the title and description, is to synchronize the project's version number across various configuration and documentation files, incrementing it from 2.2.11 to 2.2.12. This ensures consistency in dependencies and project metadata. While the description mentions minimal changes, I've observed an additional functional change in praisonai/agents_generator.py related to LLM API key handling.

Highlights

  • Version Update: The project version has been consistently updated to 2.2.12 in pyproject.toml, uv.lock, and several Dockerfile examples/templates.
  • LLM API Key Handling Adjustment: Removed explicit logic in praisonai/agents_generator.py that was overriding LLM API keys based on the config_list within the _run_crewai method.

Changelog

Click here to see the changelog
  • docker/Dockerfile
    • Updated the praisonai package version from 2.2.11 to 2.2.12 in the pip install command.
  • docker/Dockerfile.chat
    • Updated the praisonai package version from 2.2.11 to 2.2.12 in the pip install command.
  • docker/Dockerfile.dev
    • Updated the praisonai package version from 2.2.11 to 2.2.12 in the pip install command.
  • docker/Dockerfile.ui
    • Updated the praisonai package version from 2.2.11 to 2.2.12 in the pip install command.
  • docs/api/praisonai/deploy.html
    • Updated the praisonai package version from 2.2.11 to 2.2.12 within the embedded Dockerfile example string.
  • docs/developers/local-development.mdx
    • Updated the praisonai package version from 2.2.11 to 2.2.12 in the example Dockerfile content.
  • docs/ui/chat.mdx
    • Updated the praisonai package version from 2.2.11 to 2.2.12 in the example Dockerfile content.
  • docs/ui/code.mdx
    • Updated the praisonai package version from 2.2.11 to 2.2.12 in the example Dockerfile content.
  • praisonai/agents_generator.py
    • Removed the api_key_var=None parameter from PraisonAIModel instantiation.
    • Removed the conditional logic that explicitly set llm.api_key and function_calling_llm.api_key from self.config_list.
  • praisonai/deploy.py
    • Updated the praisonai package version from 2.2.11 to 2.2.12 within the generated Dockerfile string.
  • pyproject.toml
    • Updated the project version from 2.2.11 to 2.2.12 in the [project] section.
    • Updated the project version from 2.2.11 to 2.2.12 in the [tool.poetry] section.
  • uv.lock
    • Updated the locked praisonai package version from 2.2.11 to 2.2.12.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


Version bumps appear,
Small numbers, big release near,
Code flows, bugs disappear.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

The pull request successfully updates the PraisonAI version to 2.2.12 across pyproject.toml, uv.lock, and the various Dockerfiles and documentation files, ensuring version consistency as intended. This is a straightforward and necessary change for a version bump.

However, I've identified a significant change in praisonai/agents_generator.py related to how API keys are handled for CrewAI models, which might impact existing user configurations. Additionally, the current test suite doesn't fully cover this specific change.

Summary of Findings

  • Change in API Key Loading for CrewAI: The explicit override of the LLM's API key using the value from config_list in the YAML file has been removed in praisonai/agents_generator.py. This means API keys for CrewAI models are now strictly loaded via environment variables as handled by the PraisonAIModel class. This is a breaking change for users who previously specified API keys directly in their config_list YAML entries.
  • Incomplete Test Coverage: The existing integration tests (tests/integration/test_base_url_api_base_fix.py) primarily focus on base_url mapping and do not specifically test the scenario where an api_key is provided in the config_list YAML entry. Adding a test case for this scenario would help ensure the intended behavior (whether it's to now ignore the YAML key or to handle it differently) is correctly implemented and prevent regressions.

Merge Readiness

The core purpose of the PR (version update) is achieved, but the change in API key loading logic for CrewAI agents in praisonai/agents_generator.py is a high-severity issue as it might break existing user setups. I recommend addressing this potential breaking change (either by restoring compatibility or clearly documenting the new requirement) and adding a test case for it before merging. I am unable to approve this pull request; please ensure other reviewers approve it before merging.

Comment on lines 438 to -446
if llm_model:
llm = PraisonAIModel(
model=llm_model.get("model") or os.environ.get("MODEL_NAME") or "openai/gpt-4o",
api_key_var=None, # Don't rely on env var lookup
base_url=self.config_list[0].get('base_url') if self.config_list else None
).get_model()
# Override with explicit API key from config_list
if self.config_list and self.config_list[0].get('api_key'):
llm.api_key = self.config_list[0]['api_key']
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

It looks like the logic to explicitly override the LLM's API key using self.config_list[0].get('api_key') after creating the PraisonAIModel instance has been removed here and in subsequent blocks for function_calling_llm.

Previously, if a user provided an api_key directly in the config_list entry within their agents.yaml (or equivalent config), that key would be used to set the llm.api_key attribute. With this change, the PraisonAIModel will now rely solely on its internal logic to determine the API key, which primarily involves looking up environment variables based on the model prefix (e.g., OPENAI_API_KEY, GROQ_API_KEY, etc.).

This change simplifies the code but potentially breaks backward compatibility for users who were providing API keys directly in their YAML configuration config_list entries instead of environment variables. Should we document this change in behavior or consider restoring the ability to load the API key from config_list for backward compatibility?

@netlify
Copy link
Copy Markdown

netlify bot commented May 24, 2025

Deploy Preview for praisonai ready!

Name Link
🔨 Latest commit 059591f
🔍 Latest deploy log https://app.netlify.com/projects/praisonai/deploys/68324158e2a5d600084e8b44
😎 Deploy Preview https://deploy-preview-511--praisonai.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant